Skip to content

notebooks: Edited validator permissions + added links to training#370

Merged
validbeck merged 2 commits intomainfrom
beck/ownership-edit
May 14, 2025
Merged

notebooks: Edited validator permissions + added links to training#370
validbeck merged 2 commits intomainfrom
beck/ownership-edit

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented May 13, 2025

Pull Request Description

What

  • Updated the "ValidMind for model validation" introductory notebook section where validator credentials are discussed:
Old New
Screenshot 2025-05-13 at 10 19 54 AM Screenshot 2025-05-13 at 10 20 03 AM
  • Added links out to the fundamentals training at the top of all the notebooks to direct users to them now that they are being updated:
Developer Validator
Screenshot 2025-05-13 at 10 20 36 AM Screenshot 2025-05-13 at 10 20 40 AM

Why

Slack conversation

We updated the library so that users can't be selected as a model owner or developer if also a validator when logging validation tests.

How to Test

You can just look at the git diffs:

https://github.com/validmind/validmind-library/pull/370/files

Pull Request Dependencies

validmind/documentation#713 from the documentation repo depends on this update.

External Release Notes

n/a

Deployment Notes

n/a

Breaking Changes

n/a

Screenshots/Videos (Frontend Only)

n/a

Checklist

  • PR body describes what, why, and how to test
  • Release notes written — N/A
  • Deployment notes written — N/A
  • Breaking changes identified — N/A
  • Labels applied
  • PR linked to Shortcut — sc-10336
  • Screenshots/videos added (Frontend)
  • Unit tests added (Backend) — N/A
  • Tested locally — N/A
  • Documentation updated (if required)

Areas Needing Special Review

n/a

Additional Notes

n/a

@validbeck validbeck self-assigned this May 13, 2025
@validbeck validbeck added the internal Not to be externalized in the release notes label May 13, 2025
@validbeck validbeck requested review from cachafla and nrichers May 13, 2025 17:21
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

@github-actions
Copy link
Contributor

PR Summary

This pull request enhances several tutorial notebooks within the ValidMind project by adding 'Learn by Doing' sections. These sections are designed to provide users with additional resources and a more in-depth introduction to the ValidMind Platform. The changes include:

  • Addition of informational alert blocks in the following notebooks:
    • 1-set_up_validmind.ipynb
    • 2-start_development_process.ipynb
    • 3-integrate_custom_tests.ipynb
    • 4-finalize_testing_documentation.ipynb
    • 1-set_up_validmind_for_validation.ipynb
    • 2-start_validation_process.ipynb
    • 3-developing_challenger_model.ipynb
    • 4-finalize_validation_reporting.ipynb

These alert blocks provide links to the 'Developer Fundamentals' and 'Validator Fundamentals' courses, which are tailored for users new to ValidMind. The courses offer a comprehensive introduction to the platform, enhancing the learning experience for both developers and validators.

Additionally, a minor correction was made in the 1-set_up_validmind_for_validation.ipynb notebook to update the role removal instructions from 'developer' to 'model owner'.

Version updates in pyproject.toml and __version__.py files are not functionally significant and are omitted from this summary.

Test Suggestions

  • Verify that the 'Learn by Doing' sections are correctly displayed in each modified notebook.
  • Check that the links in the 'Learn by Doing' sections direct to the correct course registration pages.
  • Ensure that the alert blocks are styled consistently across all notebooks.
  • Test the role removal instructions in 1-set_up_validmind_for_validation.ipynb to confirm they are accurate and clear.

@validbeck validbeck merged commit 3eeea0f into main May 14, 2025
7 checks passed
@validbeck validbeck deleted the beck/ownership-edit branch May 14, 2025 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants